home *** CD-ROM | disk | FTP | other *** search
/ BBS in a Box 11 / AMUG BBS in a Box Volume XI (April 1994) (MacWizards).iso / Files / Util / B / Binary Pump 1.03.sit / Documentation < prev    next >
Encoding:
Text File  |  1994-01-17  |  10.1 KB  |  147 lines  |  [TEXT/ttxt]

  1. Binary Pump 1.02
  2. ---------------
  3.  
  4.  
  5. Binary pump is a simple utility which attempts to recognize files by their contents, and sets their file types and creators correctly.
  6.  
  7. When are the file types and creators NOT correct? Well, when you transfer files between Macintosh's, you usually use something called MacBinary.  This allows Mac's to correctly transfer things like creation date and file type and creator appropriately. But when you transfer from IBM PCs, Unix, or VAX systems, which don't use MacBinary, you will usually get a generic file type and creator. Thus, you won't be able to do normal mac things to these files, such as open them by double-clicking (you'll get the "The  Application that created this file cannot by found", or you'll end up running your communications program!)
  8.  
  9. One exception to this rule (maybe more than one...) is the program Zterm. I think since version .85, it has been able to correctly recognize files transfered from foreign (non-macbinary) systems. To its credit, much of Binary Pump has been modeled around Zterm's implementation of this  feature. But Zterm falls a little short in some areas, the main one being customizability.  
  10.  
  11. In order to customize Zterm's file recognition, you have to open up Zterm with resedit, create a new string, and then enter the file recognition information in the correct format. This is pretty crude to say the least. Fortunately for Zterm users, its author stuck in plenty of file types to satisfy most users.
  12.  
  13. In addition, many other (commercial or shareware) programs, do not support this feature, which I have found to be very convenient.
  14.  
  15. By the way, this program is NOT a macbinary filter.  If you download a file which was uploaded in Macbinary format using binary (instead of Macbinary), this program will NOT normally interpret that Macbinary info. There are some programs like stuffit deluxe which can do this. Maybe i'll add this in the future.  If you think you'd really like this feature, write me and i'll put it in.
  16.  
  17. Usage
  18. -----
  19.  
  20. There's really not much to explain here. To convert your files, simply drag and drop them onto Binary Pump.
  21.  
  22. Binary Pump was made to be very unobstrusive, thus it doesn't give much of a response.  Currently, all it does is flash a watch on the screen _very_ quickly.  If no tag was found for a file, an exclamation mark will flash _very_ quickly.  I did this on purpose since I hate it when Dialogs,sounds, or otherwise pop up on the screen, slowing the process down.  If you want some sort of report at the end of file conversion, ask me and i'll stick it in as some sort of option.
  23.  
  24. Note: When processing many files (over 80 or so), Binary Pump's default memory setting of 64KB is not enough.  Allocating more memory will solve the problem.
  25. In addition, if you've added many entries to the tag entry table (30 or so), Binary Pump will also be more likely to run out of memory.
  26.  
  27. If you don't have System 7.0, these methods will work:
  28.  
  29. An alternative method is to launch Binary Pump (by double-clicking) and then openning each file to convert from the File menu.
  30.  
  31. Yet another alternative method is to get into your comm program's transfer settings area.  Set the Creator Type of Binary files to BINP Now, whenever you have a binary file that's been transfered without macbinary, you can double click on it (or a group of files), and have Binary Pump automatically convert them. If you use Microphone II, this setting should be in the Settings->Protocal Transfer dialog box, in the top part of the window, in the area with the 'Auto Detect' checkbox.
  32.  
  33. If you indirectly run Binary Pump, (i.e. through drag and drop or double- clickin on files, other than the Binary Pump application), Binary Pump  will automatically quit after converting the requested files.
  34.  
  35.  
  36. AppleEvents
  37.  
  38. In System 7.0 and later, it should be possible to send an ODOC appleevent to Binary pump, with a descriptor list of files to convert. In this case, Binary Pump must already be running.
  39.  
  40. Or, you can send an apple event to the finder, and have it launch Binary Pump and open the desired files.  Binary Pump will automatically quit when the files have been converted.
  41.  
  42. Customization
  43. -------------
  44.  
  45. This is Binary Pump's strong suite.  Customization is fairly simple.
  46.  
  47. To Add a new entry to Binary Pump:
  48.  
  49. 1. Choose Edit Table… from the File Menu.    A window containing a list of entries will appear.
  50.  
  51. 2. Enter a binary tag or a file name extension in the area labeled "Tag"    File name extensions _must_ have a leading period. e.g., .jpg or .gif    The maximum length for a tag or extension is 39 characters.    The tag must also be unique -- it can't already exist in the entry    list.  See replacing entries down below for more info.    Also, tag's are case sensitive!!     3. Enter a File Type  and Creator in the corresponding areas.    File Types and Creators _must_ be 4 characters.  Binary Pump will    not accept anything else.    File Types and Creators are also case sensitive!     4. Click on the New button.    A new entry will be created in the entry list.    If Binary Pump beeps, see if you met the requirements in steps 2 and 3.    If the tag has any non-displayable characters, it will be displayed    as <*> in the entry list.         Normally, binary tags aren't very easy to obtain. Some files have simple ones like 'GIF8' for gif files. Others have weird and unrecognizable ones.  Thus, binary pump offers two ways to extract these tags from files.
  52.  
  53. "Scan 4 char" will simply take the first 4 characters of a file and use it as a tag.
  54.  
  55. Unfortunately, not all files (and in fact, fairly few) use 4 character tags at the beginning of their files.
  56.  
  57. "Scan 2 file" will ask you to find two files (the fiel dialog will appear twice!). It is imperative that you _not_ choose the same file both times!!!! Scan 2 File takes two different files of the same type, and finds the similarities. The philosophy behind this is that if the PCX file a and the PCX file b have x  letters in common, any future files which share these x letters will be a PCX file also.  Although this method is better than "Scan 4 char", it's still not fullproof.  Some programs store signatures/similarities at offsets from the beggining of othe file.  In this case, using a file name extension (e.g., .jpg) is your only choice.
  58.  
  59. In addition to binary tags, you have to supply file type and creator information. Although this information is generally easier to obtain, it can be nonetheless a pain in the butt.  Therefore, the "Creator…" and "Type…" buttons get this information for you! There are two ways to use these buttons.  The easy way is when you have a file with the file type and creator you want.  In this case, click on the Creator… button and choose the file.  Then, click  on the Type… button and choose the same file. The slightly more complex way is for situations in which you don't have a file with the correct attributes. In this case, click on the Creator… button and choose the Application (i.e. Photoshop, MS Word) that you want. Next, click on the Type… button and choose a file which is the type (e.g. JPEG, MS Word,GIF)  you want; if you don't have a file for this, you'll have to find this information  out on your own.
  60.  
  61.  
  62. To Replace or change an entry in Binary Pump:
  63.  
  64. 1. Click on the entry to replace.
  65.  
  66. 2. Alter the entry -- change the tag, owner, or type.
  67.  
  68. 3. Click on the Replace button.
  69.  
  70.  
  71.  
  72. To Delete an entry:
  73.  
  74. 1. Click on the entry to delete.
  75.  
  76. 2. Click on the Delete button.
  77.  
  78. More Advanced Stuff
  79. -------------------
  80.  
  81. Replacing
  82.  
  83. Normally, when you click on an entry in a list, Binary Pump will update the tag, creator, and type fields.  This can be inconveniencing if you want to replace an entry which is not currently selected.  Thus, if you hold the option key and click on an entry, Binary Pump will _not_ update the fields. Be a little careful when using this since this allows you to create duplicate entries (entries with identical tags). This is not damaging to Binary Pump, but can make things confusing.
  84.  
  85.  
  86. Precedence
  87.  
  88. What if Binary Pump comes across a file that has _both_ a binary tag entry and a file name extension entry? Simply put, binary tags have precedence.
  89.  
  90. In addition, if you ever _do_ create duplicate entries (this is normally not possible), Binary Pump will use the first one entered.
  91.  
  92. Memory
  93.  
  94. Binary Pump takes up very little memory.  I've set the memory limit at 64k right now, but if you're really tight on memory, it can probably go to as low as 25-30k.  But in the event you have entered many entries into the tag table, or you process a large number of files at once, a memory setting greater than the default 64kb may be required.
  95.  
  96.  
  97. Disclaimer
  98. -------------------
  99.  
  100. Here we go again with liabily stuff and such: Use this software at your own risk!
  101.  
  102.  
  103. Distribution
  104. -------------
  105.  
  106. This software may be used free of charge.
  107.  
  108. Feel free to non-commercially distribute this software to any BBS's and such provided that you distribute _only_ the original files and _all_ of the files that were in the archive.  Commercial distribution is prohibited without prior permission.
  109.  
  110.  
  111.  
  112. Source Code
  113. -----------
  114.  
  115. Source code is available.  If you want it, ask me.  No guarentees about readability though.  I will try to go through the code and clean it up some (if only so I will be able to read it better!), but this software was pieced together in about 11 hours of time in which lotsa ugly code crept in.
  116.  
  117. Version History
  118. --------------
  119.  
  120. 1.03
  121.     -- Fixed problem with tag identification.
  122.     -- Binary Pump Now gives background events some processing time when 
  123.     files are opened via apple events (i.e. Drag and Drop).  This is useful when
  124.     processing many files (80 or so...) at once and you're running background apps
  125.     (i.e. downloading a file in the background) .
  126.  
  127. 1.02
  128.     -- Binary Pump now skips files that are open from another application
  129.     -- Separated Creator & Type button into Creator… and Type… buttons.
  130.     -- Binary Pump now updates file icons and type immediately
  131.     -- Scan 2 Files alerts users when they choose the same file twice
  132.     -- When looking for file name extension, Binary Pump now scans the string
  133.     backwards instead of forwards.
  134.  
  135. 1.01
  136.     -- Revised code for Sytem 6.07 users
  137.     -- minor bugs fixes
  138.  
  139.  
  140. How to Reach Me
  141. ---------------
  142.  
  143. Internet: eshieh@cory.berkeley.edu
  144. Compuserve: 76164,765
  145. Snail Mail: Eric Shieh, P.O. Box 1235, Danville, CA 94526, USA
  146.  
  147.